Interface Port

All Superinterfaces:
IPCObject, Process
All Known Subinterfaces:
CloudPotsPort, CloudSerialPort, ConsolePort, CustomIO, FRSubInterface, HostPort, IoEComponent, RoutedSwitchPort, RouterPort, SwitchPort, UsbPort, VirtualTemplateInterface
All Known Implementing Classes:
CloudPotsPortImpl, CloudSerialPortImpl, ConsolePortImpl, CustomIOImpl, FRSubInterfaceImpl, HostPortImpl, IoEComponentImpl, PortImpl, RoutedSwitchPortImpl, RouterPortImpl, SwitchPortImpl, UsbPortImpl, VirtualTemplateInterfaceImpl

public interface Port extends Process
Information provided by the PKI file:

    \class Port
    
    \brief Port holds and manipulates the ports on devices.
    
    \example network().getDevice("Router0").getPort("FastEthernet0/0")
    
Author:
Auto-generated
  • Method Details

    • getName

      String getName()
      Information provided by the PKI file:
      
          \brief Returns the name of the port.
          
          \return string, the name of the port.
          
              
      Returns:
      String Returns a String
    • getChannel

      int getChannel()
      Information provided by the PKI file:
      
          \brief Returns the channel of the port.
          
          \return int, the channel of the port.
          
              
      Returns:
      int Returns a int
    • setChannel

      void setChannel(int channel)
      Information provided by the PKI file:
      
          \brief Sets the channel of the port.
          
          \channel, the channel of the port.
          
              
      Parameters:
      channel - Takes in a parameter of channel
    • getTerminalTypeShortString

      String getTerminalTypeShortString()
      Information provided by the PKI file:
      
          \brief Returns the name of the port shortened, without number.
          
          \return string, the name of the port.
          
              
      Returns:
      String Returns a String
    • getPortNameNumber

      String getPortNameNumber()
      Information provided by the PKI file:
      
          \brief Returns the port number.  Can have something like 0/0/0, etc.
          
          \return string, the name of the port.
          
              
      Returns:
      String Returns a String
    • getType

      PortType getType()
      Information provided by the PKI file:
      
          \brief Returns the type of the port.
          
          \return PortType,   the type of the port.
          Port types: eConsole = 0,
          eAux = 1,
          eCopperEthernet = 2,
          eCopperFastEthernet = 3,
          eCopperGigabitEthernet = 4,
          eFiberFastEthernet = 5,
          eFiberGigabitEthernet = 6,
          eSerial = 7,
          eSmartSerial = 8,
          eAccessPointWirelessG = 9,
          eAccessPointWirelessN = 10,
          eAccessPointWirelessA = 11,
          eHostWirelessG = 12,
          eHostWirelessN = 13,
          eSubInterface = 14,
          eLoopback = 15,
          ePortChannel = 16,
          eVlan = 17,
          eModem = 18,
          eRs232 = 19,
          eFRSubInterface = 20,
          eCopperCoaxial = 21,
          eCoaxial7 = 22,
          eVirtualLink = 23,
          eHostWirelessA = 24,
          eTunnel = 25,
          eVirtualTemplate = 26,
          ePtCoAxialSplitterModule = 27,
          eVirtualAccess = 28,
          eTerminal = 29,
          eAsync = 30,
          eNull = 31,
          eWlanGigabitEthernet = 32,
          eWlanConsole = 33,
          eBVI = 34,
          eAccessPoint3G = 35,
          eHost3G = 36,
          eUsbPort = 37,
          eGenericIoE = 38,
          eCustomIO = 39,
          eVirtualPortGroup = 40,
          ePoE = 41,
          eTty = 42,
          eUsbConsole = 43
          
              
      Returns:
      PortType Returns a PortType
    • setDescription

      void setDescription(String description)
      Information provided by the PKI file:
      
          \brief Sets the description for the port.
          
          \param description, the description for the port.
          
              
      Parameters:
      description - Takes in a parameter of description
    • getDescription

      String getDescription()
      Information provided by the PKI file:
      
          \brief Returns the description of the port.
          
          \return string, the description of the port.
          
              
      Returns:
      String Returns a String
    • setPower

      void setPower(boolean bOn)
      Information provided by the PKI file:
      
          \brief Sets the power state for the port.
          
          \param bOn, true to turn the port on, false to turn it off.
          
              
      Parameters:
      bOn - Takes in a parameter of bOn
    • getPower

      boolean getPower()
      Information provided by the PKI file:
      
          \brief Returns true if the port is on, false if the port is off.
          
          \return bool, true if the port is on, false if the port is off.
          
              
      Returns:
      boolean Returns a boolean
    • isStraightPins

      boolean isStraightPins()
      Information provided by the PKI file:
      
          \brief Returns true if the pins are straight, for ethernet
          
          \return bool, true if the pins are straight, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isAutoCross

      boolean isAutoCross()
      Information provided by the PKI file:
      
          \brief Returns true if the port is configured for auto crossover, for ethernet
          
          \return bool, true if the port is configured for auto crossover, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setBandwidth

      void setBandwidth(int bandwidth)
      Information provided by the PKI file:
      
          \brief Sets the bandwidth for the port.
          
          \param bandwidth, the bandwidth for the port.
          
              
      Parameters:
      bandwidth - Takes in a parameter of bandwidth
    • getBandwidth

      int getBandwidth()
      Information provided by the PKI file:
      
          \brief Returns the bandwidth of the port.
          
          \return int, the bandwidth of the port.
          
              
      Returns:
      int Returns a int
    • setBandwidthAutoNegotiate

      void setBandwidthAutoNegotiate(boolean autoNegotiate)
      Information provided by the PKI file:
      
          \brief Enables or disables bandwidth auto negotiation.
          
          \param autoNegotiate, true to enable bandwidth auto negotiation, false to disable it.
          
              
      Parameters:
      autoNegotiate - Takes in a parameter of autoNegotiate
    • isBandwidthAutoNegotiate

      boolean isBandwidthAutoNegotiate()
      Information provided by the PKI file:
      
          \brief Returns true if bandwidth auto negotiation is enabled, otherwise false.
          
          \return bool, true if bandwidth auto negotiation is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setFullDuplex

      void setFullDuplex(boolean fullDuplex)
      Information provided by the PKI file:
      
          \brief Enables or disables full duplex mode.
          
          \param fullDuplex, true to enable full duplex mode, false to disable it.
          
              
      Parameters:
      fullDuplex - Takes in a parameter of fullDuplex
    • isFullDuplex

      boolean isFullDuplex()
      Information provided by the PKI file:
      
          \brief Returns true if full duplex mode is enabled, otherwise false.
          
          \return bool, true if full duplex mode is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setDuplexAutoNegotiate

      void setDuplexAutoNegotiate(boolean autoNegotiate)
      Information provided by the PKI file:
      
          \brief Enables or disables duplex auto negotiation.
          
          \param autoNegotiate, true to enable duplex auto negotiation, false to disable it.
          
              
      Parameters:
      autoNegotiate - Takes in a parameter of autoNegotiate
    • isDuplexAutoNegotiate

      boolean isDuplexAutoNegotiate()
      Information provided by the PKI file:
      
          \brief Returns true if duplex auto negotiation is enabled, otherwise false.
          
          \return bool, true if duplex auto negotiation is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setMacAddress

      void setMacAddress(MACAddress macAddress)
      Information provided by the PKI file:
      
          \brief Sets the MAC address on the port.
          
          \param macAddress, the MAC address to set on the port.
          
              
      Parameters:
      macAddress - Takes in a parameter of macAddress
    • getMacAddress

      MACAddress getMacAddress()
      Information provided by the PKI file:
      
          \brief Returns the MAC address set on the port.
          
          \return mac, the MAC address set on the port.
          
              
      Returns:
      MACAddress Returns a MACAddress
    • getBia

      MACAddress getBia()
      Information provided by the PKI file:
      
          \brief Returns the burned-in address of the port.
          
          \return mac, the burned-in address of the port.
          
              
      Returns:
      MACAddress Returns a MACAddress
    • setClockRate

      void setClockRate(int clockrate)
      Information provided by the PKI file:
      
          \brief Sets the clock rate on the port.
          
          \param clockrate, the clock rate to set on the port.
          
              
      Parameters:
      clockrate - Takes in a parameter of clockrate
    • getClockRate

      int getClockRate()
      Information provided by the PKI file:
      
          \brief Returns the clock rate on the port.
          
          \return int, the clock rate on the port.
          
              
      Returns:
      int Returns a int
    • getLink

      Link getLink()
      Information provided by the PKI file:
      
          \brief Returns the link connected to the port.
          
          \return Link, the Link object connected to the port.
          
              
      Returns:
      Link Returns a Link
    • isProtocolUp

      boolean isProtocolUp()
      Information provided by the PKI file:
      
          \brief Returns true if the line protocol is up on the port, otherwise false.
          
          \return bool, true if the line protocol is up on the port, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isPortUp

      boolean isPortUp()
      Information provided by the PKI file:
      
          \brief Returns true if the status is up on the port, otherwise false.
          
          \return bool, true if the status is up on the port, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getEncapProcess

      Process getEncapProcess()
      Information provided by the PKI file:
      
          \brief Returns the encapsulation process.
          
          \return Process, the Process object.
          
              
      Returns:
      Process Returns a Process
    • getKeepAliveProcess

      Process getKeepAliveProcess()
      Information provided by the PKI file:
      
          \brief Returns the keepalive process.
          
          \return Process, the Process object.
          
              
      Returns:
      Process Returns a Process
    • getLightStatus

      LightStatus getLightStatus()
      Information provided by the PKI file:
      
          \brief Returns the link light status.
          
          \return LightStatus, the link light status.
          Link light statuses:        eOffLight = 0,
          eAmberLight = 1,
          eGreenLight = 2,
          eBlink = 3
          
              
      Returns:
      LightStatus Returns a LightStatus
    • getHigherProcessCount

      int getHigherProcessCount()
      Information provided by the PKI file:
      
          \brief Returns the higher process count.
          
          \return int, the higher process count.
          
              
      Returns:
      int Returns a int
    • getHardwareQueue

      HardwareQueue getHardwareQueue()
      Information provided by the PKI file:
      
          \brief Returns the hardware queue.
          
          \return HardwareQueue, the hardware queue.
          
              
      Returns:
      HardwareQueue Returns a HardwareQueue
    • getQosQueue

      QueueProcess getQosQueue()
      Information provided by the PKI file:
      
          \brief Returns the qos queue.
          
          \return QueueProcess, the qos queue.
          
              
      Returns:
      QueueProcess Returns a QueueProcess
    • isEthernetPort

      boolean isEthernetPort()
      Information provided by the PKI file:
      
          \brief Returns true if it is a ethernet port, false if not.
          
          \return bool, true if it is a ethernet port, false if not.
          
              
      Returns:
      boolean Returns a boolean
    • isWirelessPort

      boolean isWirelessPort()
      Information provided by the PKI file:
      
          \brief Returns true if it is a wireless port, false if not.
          
          \return bool, true if it is a wireless port, false if not.
          
              
      Returns:
      boolean Returns a boolean
    • isPowerOn

      boolean isPowerOn()
      Information provided by the PKI file:
      
          \brief Returns true if the power is on, false if not.
          
          \return bool, true if the power is on, false if not.
          
              
      Returns:
      boolean Returns a boolean
    • deleteLink

      void deleteLink()